Fix incorrect example in wide_to_long docstring #25736

bharatr21 · 2019-03-14T19:04:31Z

closes Incorrect example in wide_to_long docstring #25733
tests added / passed
passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

codecov · 2019-03-14T19:43:52Z

Codecov Report

Merging #25736 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #25736   +/-   ##
=======================================
  Coverage   91.25%   91.25%           
=======================================
  Files         172      172           
  Lines       52973    52973           
=======================================
  Hits        48338    48338           
  Misses       4635     4635

Flag	Coverage Δ
#multiple	`89.82% <ø> (ø)`	⬆️
#single	`41.74% <ø> (ø)`	⬆️

Impacted Files	Coverage Δ
pandas/core/reshape/melt.py	`97.5% <ø> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9eec9b8...5bda59c. Read the comment docs.

codecov · 2019-03-14T19:43:58Z

Codecov Report

Merging #25736 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #25736   +/-   ##
=======================================
  Coverage   91.26%   91.26%           
=======================================
  Files         173      173           
  Lines       52982    52982           
=======================================
  Hits        48356    48356           
  Misses       4626     4626

Flag	Coverage Δ
#multiple	`89.83% <ø> (ø)`	⬆️
#single	`41.75% <ø> (ø)`	⬆️

Impacted Files	Coverage Δ
pandas/core/reshape/melt.py	`97.5% <ø> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4663951...b182905. Read the comment docs.

TomAugspurger

Can you post the output of python scripts/validate_docstrings.py pandas.wide_to_long

And, it's not necessary, but it would be good to run all these in CI. Can you add

diff --git a/ci/code_checks.sh b/ci/code_checks.sh
index 51df77934..5ab33e7e2 100755
--- a/ci/code_checks.sh
+++ b/ci/code_checks.sh
@@ -223,6 +223,7 @@ if [[ -z "$CHECK" || "$CHECK" == "doctests" ]]; then
     MSG='Doctests top-level reshaping functions' ; echo $MSG
     pytest -q --doctest-modules \
         pandas/core/reshape/concat.py \
+        pandas/core/reshape/melt.py \
         pandas/core/reshape/pivot.py \
         pandas/core/reshape/reshape.py \
         pandas/core/reshape/tile.py \

and ensure that things pass with pytest --doctest-modules pandas/core/reshape/melt.py. May need to change a couple more things.

TomAugspurger · 2019-03-14T19:47:19Z

pandas/core/reshape/melt.py

@@ -386,7 +386,7 @@ def wide_to_long(df, stubnames, i, j, sep="", suffix=r'\d+'):
    8      3      3     2.1     2.9

    >>> l = pd.wide_to_long(df, stubnames='ht', i=['famid', 'birth'], j='age',
-                            sep='_', suffix='\w')
+                            sep='_', suffix='\w+')


Need ... under the >>>.

Errors:

################################### Doctests ################################### ################################################################################ ********************************************************************** Line 94, in pandas.wide_to_long Failed example: df Expected: birth famid ht1 ht2 0 1 1 2.8 3.4 1 2 1 2.9 3.8 2 3 1 2.2 2.9 3 1 2 2.0 3.2 4 2 2 1.8 2.8 5 3 2 1.9 2.4 6 1 3 2.2 3.3 7 2 3 2.3 3.4 8 3 3 2.1 2.9 Got: famid birth ht1 ht2 0 1 1 2.8 3.4 1 1 2 2.9 3.8 2 1 3 2.2 2.9 3 2 1 2.0 3.2 4 2 2 1.8 2.8 5 2 3 1.9 2.4 6 3 1 2.2 3.3 7 3 2 2.3 3.4 8 3 3 2.1 2.9 ********************************************************************** Line 154, in pandas.wide_to_long Failed example: df # doctest: +NORMALIZE_WHITESPACE, +ELLIPSIS Expected: A(quarterly)-2010 A(quarterly)-2011 B(quarterly)-2010 ... 0 0.548814 0.544883 0.437587 ... 1 0.715189 0.423655 0.891773 ... 2 0.602763 0.645894 0.963663 ... X id 0 0 0 1 1 1 2 1 2 Got: A(quarterly)-2010 A(quarterly)-2011 B(quarterly)-2010 B(quarterly)-2011 X id 0 0.548814 0.544883 0.437587 0.383442 0 0 1 0.715189 0.423655 0.891773 0.791725 1 1 2 0.602763 0.645894 0.963663 0.528895 1 2 ********************************************************************** Line 195, in pandas.wide_to_long Failed example: df Expected: birth famid ht_one ht_two 0 1 1 2.8 3.4 1 2 1 2.9 3.8 2 3 1 2.2 2.9 3 1 2 2.0 3.2 4 2 2 1.8 2.8 5 3 2 1.9 2.4 6 1 3 2.2 3.3 7 2 3 2.3 3.4 8 3 3 2.1 2.9 Got: famid birth ht_one ht_two 0 1 1 2.8 3.4 1 1 2 2.9 3.8 2 1 3 2.2 2.9 3 2 1 2.0 3.2 4 2 2 1.8 2.8 5 2 3 1.9 2.4 6 3 1 2.2 3.3 7 3 2 2.3 3.4 8 3 3 2.1 2.9

and after my attempted fix,

################################################################################ ################################### Doctests ################################### ################################################################################ ********************************************************************** Line 154, in pandas.wide_to_long Failed example: df # doctest: +NORMALIZE_WHITESPACE, +ELLIPSIS Expected: A(quarterly)-2010 A(quarterly)-2011 B(quarterly)-2010 ... 0 0.548814 0.544883 0.437587 ... 1 0.715189 0.423655 0.891773 ... 2 0.602763 0.645894 0.963663 ... X id 0 0 0 1 1 1 2 1 2 Got: A(quarterly)-2010 A(quarterly)-2011 B(quarterly)-2010 B(quarterly)-2011 X id 0 0.548814 0.544883 0.437587 0.383442 0 0 1 0.715189 0.423655 0.891773 0.791725 1 1 2 0.602763 0.645894 0.963663 0.528895 1 2

The ELLIPSIS is not being considered or ignored by doctest as it ought to be. Perhaps another PR?

The doctest, and hence the entire pipeline is failing only due to this ELLIPSIS error @TomAugspurger any suggestions on what to do? (If I put all columns, pylint and flake8 fails because it exceeds 79 chars)

Answered in
https://github.com/pandas-dev/pandas/pull/25736/files#r265931954

doc/source/whatsnew/v0.25.0.rst

…gspurger

…gspurger and @jreback

pandas/core/reshape/melt.py

doc/source/whatsnew/v0.25.0.rst

TomAugspurger · 2019-03-15T11:33:30Z

How does pytest --doctest-modules pandas/core/reshape/melt.py look now?

TomAugspurger · 2019-03-15T12:35:46Z

Looks like you're close! https://dev.azure.com/pandas-dev/pandas/_build/results?buildId=9462&view=logs&jobId=10b0523a-38de-5c7a-02e7-c2259d583b33&taskId=72638d9d-eff6-5eec-7c2f-7fe1a320272e&lineStart=37&lineEnd=38&colStart=1&colEnd=1

You can hopefully fit all the columns in a line.

TomAugspurger · 2019-03-15T16:47:25Z

pandas/core/reshape/melt.py

+    0           0.548814           0.544883           0.437587  ...  0  0
+    1           0.715189           0.423655           0.891773  ...  1  1
+    2           0.602763           0.645894           0.963663  ...  2  2
+


Can delete this line I think.

TomAugspurger · 2019-03-15T16:47:53Z

pandas/core/reshape/melt.py

-    0  0   0
-    1  1   1
-    2  1   2
+       A(quarterly)-2010  A(quarterly)-2011  B(quarterly)-2010  ...  X  id


Is the output too wide to include all the columns without any ellipses?

Yes @TomAugspurger the line is too wide to include all columns, so deleted only "B(quarterly)-2011" column (88 > 79 chars on pycodestyle and flake8)

Hrm, that's a little unfortunate as all the columns are important :/

Well, for now, let's use ellipses. FYI, your spacing is just slightly off, so it failed again :)

diff --git a/pandas/core/reshape/melt.py b/pandas/core/reshape/melt.py index cec4c609c..df144db50 100644 --- a/pandas/core/reshape/melt.py +++ b/pandas/core/reshape/melt.py @@ -334,9 +334,9 @@ def wide_to_long(df, stubnames, i, j, sep="", suffix=r'\d+'): >>> df['id'] = df.index >>> df # doctest: +NORMALIZE_WHITESPACE, +ELLIPSIS A(quarterly)-2010 A(quarterly)-2011 B(quarterly)-2010 ... X id - 0 0.548814 0.544883 0.437587 ... 0 0 - 1 0.715189 0.423655 0.891773 ... 1 1 - 2 0.602763 0.645894 0.963663 ... 2 2 + 0 0.548814 0.544883 0.437587 ... 0 0 + 1 0.715189 0.423655 0.891773 ... 1 1 + 2 0.602763 0.645894 0.963663 ... 1 2 >>> pd.wide_to_long(df, ['A(quarterly)', 'B(quarterly)'], i='id', ... j='year', sep='-')

I think you need an extra space so that the values in id are under the d.

jreback

pls merge master

doc/source/whatsnew/v0.25.0.rst

WillAyd · 2019-04-10T05:32:06Z

Closing as stale and superseded by #26010

TomAugspurger · 2019-04-10T11:42:14Z

IIRC this was quite close. Just a whitespace issue. I’d prefer we push it across the line if a maintainer or the original author has time.

…

On Apr 10, 2019, at 00:32, William Ayd ***@***.***> wrote: Closed #25736. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

Bharat123Rox and others added 2 commits March 15, 2019 00:32

Fix incorrect example in wide_to_long docstring

d472c17

Merge branch 'master' into update-docs

5bda59c

TomAugspurger reviewed Mar 14, 2019

View reviewed changes

jreback added the Docs label Mar 14, 2019

jreback requested changes Mar 14, 2019

View reviewed changes

doc/source/whatsnew/v0.25.0.rst Show resolved Hide resolved

jreback added this to the 0.25.0 milestone Mar 14, 2019

More changes to docstring, added CI, removed whatsnew courtesy @TomAu…

26a28d5

…gspurger and @jreback

TomAugspurger reviewed Mar 15, 2019

View reviewed changes

pandas/core/reshape/melt.py Outdated Show resolved Hide resolved

TomAugspurger reviewed Mar 15, 2019

View reviewed changes

doc/source/whatsnew/v0.25.0.rst Outdated Show resolved Hide resolved

Fixed ellipsis, added back whatsnew

cda32f0

Final doctest fix

aebff33

TomAugspurger reviewed Mar 15, 2019

View reviewed changes

Bharat123Rox added 2 commits March 15, 2019 23:47

Final doctest fix

87a0867

Final doctest fix

e7b1679

jreback requested changes Mar 20, 2019

View reviewed changes

doc/source/whatsnew/v0.25.0.rst Show resolved Hide resolved

Merge remote-tracking branch 'upstream/master' into update-docs

b182905

WillAyd closed this Apr 10, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix incorrect example in wide_to_long docstring #25736

Fix incorrect example in wide_to_long docstring #25736

bharatr21 commented Mar 14, 2019 •

edited

Loading

codecov bot commented Mar 14, 2019

codecov bot commented Mar 14, 2019 •

edited

Loading

TomAugspurger left a comment

TomAugspurger Mar 14, 2019

bharatr21 Mar 15, 2019

bharatr21 Mar 15, 2019

TomAugspurger Mar 15, 2019

TomAugspurger commented Mar 15, 2019

TomAugspurger commented Mar 15, 2019

TomAugspurger Mar 15, 2019

TomAugspurger Mar 15, 2019

bharatr21 Mar 15, 2019

TomAugspurger Mar 15, 2019

jreback left a comment

WillAyd commented Apr 10, 2019

TomAugspurger commented Apr 10, 2019 via email

Fix incorrect example in wide_to_long docstring #25736

Fix incorrect example in wide_to_long docstring #25736

Conversation

bharatr21 commented Mar 14, 2019 • edited Loading

codecov bot commented Mar 14, 2019

Codecov Report

codecov bot commented Mar 14, 2019 • edited Loading

Codecov Report

TomAugspurger left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TomAugspurger commented Mar 15, 2019

TomAugspurger commented Mar 15, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback left a comment

Choose a reason for hiding this comment

WillAyd commented Apr 10, 2019

TomAugspurger commented Apr 10, 2019 via email

bharatr21 commented Mar 14, 2019 •

edited

Loading

codecov bot commented Mar 14, 2019 •

edited

Loading